Carbon


KCFindX509Certificates

Header: Keychain.h Carbon status: Under Evaluation

Finds certificates in a specified keychain that match the specified search criteria.

OSStatus KCFindX509Certificates (
    KCRef keychain, 
    CFStringRef name, 
    CFStringRef emailAddress, 
    KCCertSearchOptions options, 
    CFMutableArrayRef *certificateItems
);
keychain

A reference to the keychain you want to search. If the specified keychain is locked, the Unlock Keychain dialog box is displayed.

name

A pointer to a C string containing the certificate owner's common name.

emailAddress

A pointer to a C string containing the certificate owner’s e-mail address.

options

The search criteria used when retrieving certificates. You can use the masks described in “Certificate Search Option Mask Constants” to set the criteria.

certificateItems

On return, a pointer to an array reference of the certificate items that were found. Pass NULL if you don’t want to obtain these references.

function result

A result code. The result code errKCNoDefaultKeychain indicates that no default keychain could be found. The result code errKCBufferTooSmall indicates that the certificate data was too large for the supplied buffer. In this case, your application must allocate a new buffer of sufficient size before calling KCFindX509Certificates again. The result code errKCItemNotFound indicates that no matching certificate object was found.

VERSION NOTES

Available beginning with Keychain 2.0.

AVAILABILITY

Under evaluation for Carbon. Available in CarbonLib 1.0 and later when KeychainLib 2.0 or later is installed. Exported by CarbonLib 1.0 and later and by KeychainLib 2.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)